home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / wof48.zip / WHEEL.DOC < prev    next >
Text File  |  1992-12-26  |  25KB  |  526 lines
  1.  
  2.                             WHEEL of FORTUNE
  3.  
  4.                                   v4.8
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.                                 OVERVIEW
  15.                                 ________
  16.  
  17.  
  18.    Wheel of Fortune is an adaptation of the very popular TV game show.
  19.    The game is played almost exactly the same, however, you will have to
  20.    use your imagination when it comes to who is turning the letters on
  21.    the board. I can assure you that Vanna is not doing the turning. The
  22.    game has a SAVE feature which allows the caller to quit the game and
  23.    pick up where they left off, when the caller next chooses the door.
  24.  
  25.    NOTE: Most errors will be logged to a file called DFRAME.ERR, which is
  26.          created in the directory you run the door from.
  27.  
  28.  
  29.                               INSTALLATION
  30.                               ____________
  31.  
  32.  
  33.    Installation is fairly easy and straight-forward. The following steps and
  34.    examples should have you up and running in a very short period of time.
  35.    It is assumed that you are familiar with setting up DOORS on your system.
  36.    To this end, only examples of the configuration file and Door batch file
  37.    are described.
  38.  
  39.       1) Create a directory to hold all WHEEL of FORTUNE files.
  40.  
  41.       2) Unzip WOFxx.ZIP into the the above directory.
  42.  
  43.       3) Create a configuration file, with a name of your choice, or
  44.          modify the supplied WHEEL.CFG file. A description follows:
  45.  
  46.             **                       Location of System FIle (See Below)
  47.             SUNRISE-80 BBS           Your BBS Name
  48.             Al                       Sysop's First Name
  49.             Lawrence                 Sysop's Last name
  50.  
  51. |-----------------------------------------------------------------------------|
  52. | READ!     1                        CommPort  \ These 2 lines are required   |
  53. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  54. |-----------------------------------------------------------------------------|
  55.  
  56.             00000000                 Registration Number
  57.  
  58.             50                       Number of entries in the Top Score file
  59.                                      Minimum=10, Maximum=50, Default=50
  60.  
  61.             20                       Number of puzzles each player has to solve.
  62.                                      Minimum=10, Maximum=50, Default=20
  63.  
  64.  
  65.         #   7                        NUMBER of chances given to solve each
  66.                                      puzzle. A wrong letter choice, landing
  67.                                      on "LOSE TURN" or "BANKRUPT" reduces
  68.                                      this variable by 1. When it reaches 0
  69.                                      the caller receives 100 pts, whether
  70.                                      caller has accumulateed more or not,
  71.                                      and they move on to the next puzzle.
  72.                                      This is the default!
  73.                                                     - or -
  74.  
  75.                                      LEVELS - allows caller to select a level
  76.                                      of difficulty. There are 4 levels and each
  77.                                      level carries a different number of chances
  78.                                      & a sliding percentage of the wheel points
  79.                                      caller will accumulate.
  80.  
  81.             2                        The number of players that must complete
  82.                                      all puzzles, before the puzzles are
  83.                                      changed automatically by WOFMAINT, usually
  84.                                      in your nightly event processing.
  85.  
  86.        #    3                        Number of puzzles the caller is allowed
  87.                                      to play per day.
  88.                                      (Sysop is unlimited in registered version!)
  89.  
  90.        #    NONE                     Full drive:\path\filename for Top Score
  91.                                      Bulletin, or NONE
  92.  
  93.        #    NONE                     Full drive:\path\filename for Hall of
  94.                                      Fame Bulletin, or NONE
  95.  
  96.             2                        1 = Do Not Display ADOPT-A-DOOR Message
  97.                                      2 = Display ADOPT-A-DOOR Message
  98.  
  99.  
  100.         #   2                        Keyboard Timeout Value in Minutes.
  101.                                      If key not depressed for "value" minutes
  102.                                      then game is saved. Minimum = 2 minutes
  103.  
  104.         #   N                        Y = Allow callers to add Puzzles
  105.                                      N = Do not allow callers to add Puzzles.
  106.                                      (See 'Caller Supplied Puzzles' below)
  107.  
  108.             12000                    Value used to dictate the speed the
  109.                                      wheel will spin. Since I run on a 286/12
  110.                                      I have determined that a value of 12000
  111.                                      performs well. For an 8088 CPU you would
  112.                                      lower the value and for a faster CPU you
  113.                                      would raise the value (range: 1000-15000)
  114.                                      If you find the optimum value for a
  115.                                      specific machine type, please share it
  116.                                      on the support board or thru any Sysop
  117.                                      or BBS_Door echo you have access to!
  118.  
  119.         #   Y                        Y = Allow Sysop to play as many games as
  120.                                          there are questions
  121.                                      N = Sysop just like a regular player
  122.  
  123.     @   #   XXXX/YYYY                 Blackout Range  From/To
  124.     @   #   XXXX/YYYY                 Blackout Range  From/To
  125.     @   #   XXXX/YYYY                 Blackout Range  From/To
  126.     @   #   XXXX/YYYY                 Blackout Range  From/To
  127.     @   #   XXXX/YYYY                 Blackout Range  From/To
  128.  
  129.          ** = Replace with ONE of the following:
  130.  
  131. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  132. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  133. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  134.                                    (Note:DOOR.SYS must be in SAME directory)
  135. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  136. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  137. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  138. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  139. C:\BBS\CHAIN.TXT                <- For WWIV systems
  140. C:\BBS\GTUSER.BBS               <- For GT Power
  141.                                    * if using this option you must put the
  142.                                      ComPort # on line 5 and the Node # on
  143.                                      line 6 of the configuration file
  144.  
  145.  
  146.  
  147.          # =  Requires registration to change to a different value
  148.          @ =  See "Blackout Periods" Below
  149.  
  150.  
  151.               NOTE:THERE ARE TO BE NO BLANK LINES IN THIS FILE !
  152.  
  153.       4) Run WOFMAINT WHEEL.CFG (or name you gave to config file)
  154.  
  155.           ********************* To Setup Program ****************************
  156.           *                                                                 *
  157.           *     Note filename is the filename you chose in #3 above.        *
  158.           *     ASSUMING that filename from #3 above is  WHEEL.CFG,         *
  159.           *     type the following:                                         *
  160.           *                                                                 *
  161.           *                  WOFMAINT WHEEL.CFG                          *
  162.           *                                                                 *
  163.           *******************************************************************
  164.  
  165.              Choose menu option #6. (NOTE: READ PROMPTS CAREFULLY !!!)
  166.              This will create and initialize all the required files in
  167.              the directory you created in # 1) above. The program will
  168.              display the names of the files being created. Uses config
  169.              file from #3 above! You will be returned to the main menu
  170.              after initialization. Choose option "X" to exit WOFMAINT.
  171.  
  172.       5) Create a batch file or modify the WHEEL file supplied. A
  173.          description of this file follows:
  174.  
  175.             ECHO off
  176.             CD\bbs\DOORS\WHEEL        Location of Wheel of Fortune Files
  177.             WHEEL WHEEL.CFG           EXE filename and CFG filename (Name
  178.                                       used in creating file in #3 above)
  179.             CD\bbs
  180.             BOARD
  181.  
  182.                  NOTE: THERE ARE NO BLANK LINES IN THIS FILE
  183.  
  184.        6) When running more than one node, be sure to supply a different
  185.           configuration name for each node (your choice of name) and
  186.           change the first entry in the .CFG (if necessary).
  187.  
  188.        7) If running with Fossil-based multi-port boards add
  189.            /FD to the line containing the CFG name as follows:
  190.  
  191.                          WHEEL WHEEL.CFG /FD
  192.  
  193.  
  194.  
  195.                       CALLER SUPPLIED PUZZLES
  196.                       _______________________
  197.  
  198.       If enough time remains, the caller will be given the option to enter
  199.       puzzles for you to use in the databases. This is optional and is
  200.       controlled by an entry in the CONFIG file (see Config description above).
  201.  
  202.       These entries will reside in a separate file, WOFUSER.PUZ. It will be
  203.       your responsibility to check the entries out, add a category to each one
  204.       and import them into the WHEEL and/or BONUS databases. Be sure to delete
  205.       the file when you are finished with it, as WOF will add on to the file
  206.       if it is found in the WHEEL directory. If not found it creates a new one.
  207.  
  208.       NOTE: This option is only available if Door is registered!
  209.  
  210.  
  211.                           BLACKOUT PERIODS
  212.                           ________________
  213.  
  214.       Use the Blackout ranges option to define up to 5 time periods during
  215.       which you DO NOT want the Door to be played. If a caller tries to access
  216.       the Door during the Blackout period, they will be shown a message that
  217.       contains ALL the Blackout periods you have defined, and to try the Door
  218.       at a later time.
  219.  
  220.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  221.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  222.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  223.  
  224.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  225.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  226.                    a Blackout range.
  227.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  228.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  229.  
  230.  
  231.                         NON-STANDARD COM SUPPORT
  232.                         ________________________
  233.  
  234.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  235.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  236.       number after the configuration filename. Let's assume your Door is
  237.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  238.       passed to your Door would be:
  239.  
  240.                             FOOBAR FOOBAR.CFG /5
  241.  
  242.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  243.       normally used with COM1. No /x parameter is needed for the standard
  244.       IRQ's.
  245.  
  246.       As an alternative, you may use an environmental variable on the command
  247.       line. To use the variable (following the example above), place a
  248.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  249.       different IRQ number for each node). The command line would now look
  250.       like this:
  251.  
  252.                           FOOBAR FOOBAR.CFG /%IRQ%
  253.  
  254.       This, in combination with the use of the environmental variables
  255.       described in the MULTI-NODE SETUP section will allow you to use one
  256.       batch file and one config file to run this door on all nodes.
  257.  
  258.  
  259.  
  260.  
  261.                            MULTI-NODE SETUP
  262.                            ________________
  263.  
  264.       All Sunrise Doors are Multi-Node capable. Each node must have the
  265.       ability to access a configuration file which will have its own system
  266.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  267.       line. There are 2 ways to accomplish this:
  268.  
  269.       (1) Create a separate configuration file for each node. The only
  270.           difference between each file would be the location of the system
  271.           file for that particular node. For example, on my system there are 2
  272.           nodes and the first line of the config files would look like this:
  273.  
  274.                         NODE1:  H:\PCB1\DOOR.SYS
  275.                         NODE2:  H:\PCB2\DOOR.SYS
  276.  
  277.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  278.  
  279.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  280.           the following PCBoard environmental variables:
  281.  
  282.                  PCBDIR    (Directory containing the System file)
  283.                  PCBDRIVE  (Drive containing the System file)
  284.  
  285.           Thus, the first line of the SINGLE configuration file, for this Door
  286.           would look like this:
  287.  
  288.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  289.  
  290.       NOTE: This option, as described, assumes that you are running PCBoard
  291.             14.5a software. The environmental variables are automatically
  292.             created by the software for each node.
  293.  
  294.             HOWEVER, if you are running other BBS software you should be able
  295.             to set the variables EXACTLY as described below, for EACH node
  296.             (more than likely in each batch file you use to bring up EACH node):
  297.  
  298.                             PCBDRIVE=C:
  299.                             ^^^^^^^^^
  300.                             PCBDIR=\NODE2
  301.                             ^^^^^^^^
  302.  
  303.             Info with a carat (^) under it, MUST be typed as is. The rest
  304.             depends on your naming conventions.
  305.  
  306.             This, in combination with the use of the optional environmental
  307.             variable described in the NON-STANDARD COM SUPPORT section, will
  308.             allow you to use one batch file and one config file to run this
  309.             door on all nodes.
  310.  
  311.  
  312.  
  313.  
  314.                                 WOFMAINT
  315.                                 ________
  316.  
  317.     This is the Wheel of Fortune utility maintenance progam. See below for a
  318.     list of WOFMAINT functions. To start WOFMAINt up enter the following:
  319.  
  320.  
  321.  
  322.      ********************************************************************
  323.      *                                                                  *
  324.      *   Assuming that your config file is named  WHEEL.CFG, enter the  *
  325.      *   following EXAMPLE to run WOFMAINT to maintain puzzle files.    *
  326.      *                                                                  *
  327.      *                  cd\pcb\doors\wheel                              *
  328.      *                  WOFMAINT WHEEL.CFG                              *
  329.      *                                                                  *
  330.      *   NOTE: If you are running DOS 5.0 and encounter problems with   *
  331.      *         the execution of WOFMAINT, use the following in place    *
  332.      *         of the above example:                                    *
  333.      *                                                                  *
  334.      *                  cd\pcb\doors\wheel                              *
  335.      *                  C:\DOS\LOADFIX WOFMAINT WHEEL.CFG               *
  336.      *                                                                  *
  337.      ********************************************************************
  338.  
  339.               WOFMAINT WHEEL.CFG (Substitute your config filename)
  340.  
  341.  
  342.  
  343.  
  344.  
  345.                             WOFMENU FUNCTIONS
  346.                             _________________
  347.  
  348.         (1) Manually Change Puzzles and Reset/Update Files
  349.                Creates new puzzles, Updates Hall of Fame, Resets HiScore,
  350.                Index and Save files.
  351.         (2) Add REGULAR and BONUS Puzzles to Database
  352.                Add puzzles/categories to REGULAR and BONUS puzzle database.
  353.         (3) Import a Puzzle File
  354.                Import puzzle files you have created offline with your favorite
  355.                editor or word processor. See detailed explanation below under
  356.                "OFFLINE PUZZLE CREATION".
  357.         (4) Check For REGULAR and BONUS Puzzle Duplicates
  358.                Although the program normally checks for duplicates when
  359.                entering new puzzles, this function is available if you append
  360.                a puzzle file to an existing one bypassing the normal dup check.
  361.         (5) Re-Cycle Used REGULAR and BONUS Puzzles
  362.                When puzzles are changed,the old ones are placed in a file
  363.                called WHEELQUE.OLD or BONUSQUE.OLD. At some point in time you
  364.                may want to add them back into the current database. This option
  365.                will place them at the end of the database file. If you are
  366.                recycling more than 600 puzzles, you must split the file.
  367.         (6) Initialize ALL Files (Initial Setup ONLY!)
  368.                Use only the first time you are setting up this door. It will
  369.                reset all files, so USE IT with CAUTION !!
  370.         (X) EXIT
  371.               Ends The Program
  372.  
  373.  
  374.                              EVENT PROCESSING
  375.                              ________________
  376.  
  377.     After your caller completes all the puzzles you have defined, it becomes
  378.     necessary to change them and start a new game. This task can be done
  379.     manually, using WOFMAINT (option #1) or automatically, as part of your
  380.     nightly EVENT process.
  381.  
  382.     As a nightly EVENT, WOFEVENT checks to see if the number of players, as
  383.     defined in the configuration file, have completed all puzzles, in which
  384.     case it will automatically supply a new set of puzzles and reset/update
  385.     the appropriate files. The following is an EXAMPLE of what needs to be
  386.     placed in your EVENT.SYS file (PcBoard):
  387.  
  388.  
  389.                CD\PCB\DOORS\WHEEL      Location of WOF files
  390.                WOFEVENT WHEEL.CFG     *EXE filename and config filename
  391.                CD\PCB
  392.                BOARD
  393.  
  394.  
  395.  
  396.  
  397.  
  398.                           OFFLINE PUZZLE CREATION
  399.                           _______________________
  400.  
  401.  
  402.     This Wheel of Fortune Door program has the ability to import files you
  403.     create offline, with your favorite editor or word processor. The file
  404.     format is simple:  PUZZLE,CATEGORY. The maximum length of each puzzle is
  405.     35 charcters and the maximum length of each category is 20 characters.
  406.     When this file is imported it is first checked to ensure that it conforms
  407.     to the length restrictions and then the program checks to ensure that
  408.     there is enough room in the database. If there is no room, you will
  409.     receive a message to that effect and you will have to wait until enough
  410.     puzzles are used and space is made available. If the length of any puzzle
  411.     or category is invalid, the offending puzzle will be displayed along with
  412.     which parts are in error. You will have to correct the problem and rerun
  413.     the import option.
  414.  
  415.     As a reminder, there are two (2) databases; REGULAR puzzles and BONUS
  416.     puzzles. You must create separate files for each and answer the prompt
  417.     with the appropriate file type.
  418.  
  419.     Once you have registered Wheel of Fortune you you will be able to call
  420.     Sunrise-80 BBS and pick up extra puzzles. When you log on the BBS go to
  421.     the Doors menu and choose the Door number that corresponds to "WOF puzzles".
  422.     We would appreciate it if you would contribute the puzzles you have made up,
  423.     by uploading them into the same door on out BBS.
  424.  
  425.  
  426.  
  427.                                ADOPT-A-DOOR
  428.                                ____________
  429.  
  430.  
  431.     Having been a Sysop for a number of years, I have had my share of problems
  432.     and frustrations getting financial support for my board's upkeep. A fellow
  433.     Sysop left a message on my board, not long ago, about a concept that was
  434.     being used by several boards around the country.
  435.  
  436.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  437.     would be the same as sending in a donation, only this way it is earmarked
  438.     for registering a particular door. In a way, the user feels he/she is
  439.     "getting something in return". As a Door author I have decided to build
  440.     this concept into each of my Door programs. The concept replaces the
  441.     usual message "tell the Sysop to register this Door" we find in most
  442.     doors.
  443.  
  444.     If the Door is unregisterd then a message appears on the opening screen
  445.     to that effect. After finishing or suspending a game, a message screen
  446.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  447.     caller to contact the Sysop to find out if there is any further details
  448.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  449.     time, etc to callers that ADOPT-A-DOOR.
  450.  
  451.     If the Door has been registered, either by the Sysop or other callers,
  452.     the names of those contributors will be displayed in the closing screen.
  453.  
  454.     NOTE: If you want to display the names of the callers that contributed
  455.           to registering the Door, you must create an ASCII file called
  456.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  457.           the name(s) of the contributors (one on each line, maximum of 5
  458.           entries, each a maximum of 30 characters long). This file must be
  459.           saved, in ASCII format, and placed in the Door directory.
  460.  
  461.  
  462.  
  463.                               LEGALITIES
  464.                               __________
  465.  
  466.  
  467.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  468.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  469.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  470.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  471.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  472.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  473.       OR BREACH OF ANY WARRANTY.
  474.  
  475.  
  476.  
  477.  
  478.  
  479.                              DISTRIBUTION
  480.                              ____________
  481.  
  482.    You may make this file available for downloading from your BBS or you may
  483.    upload it to any BBS of your choice, provided that you do not make any
  484.    changes to the contents of the archive (ZIP file). The archive and its
  485.    individual contents may not be used by any service that charges any money
  486.    whatsoever, without the written permission of the author.
  487.  
  488.  
  489.  
  490.  
  491.  
  492.                              REGISTRATION
  493.                              ____________
  494.  
  495.    Registration and the subsequent insertion of the registration number into
  496.    your configuation file, allows for the display of your BBS name on the
  497.    opening and closing screen as well as the reduction of a delay built into
  498.    the opening screen display along with the ability to change certain values
  499.    in the configuration file.
  500.  
  501.    To register your copy of WHEEL of FORTUNE, please fill out the registration
  502.    form (REGISTER.FRM) and mail it along with the registration fee to
  503.    the name and address on the form or supply a self-addressed stamped
  504.    envelope for registration number by return mail.t
  505.  
  506.    Be sure to use the proper upper/lower case when filling in your name and
  507.    BBS name, as they MUST match the way you entered them in the configuration
  508.    file.             ^^^^
  509.  
  510.    Based upon information supplied on the registration form, I will pre-
  511.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  512.    up your registration number.
  513.  
  514.  
  515.  
  516.                                  MISC
  517.                                  ____
  518.  
  519.    The latest version of WHEEL of FORTUNE and other fine SUNRISE DOOR programs
  520.    are always available for download from SUNRISE-80 BBS and/or SALTAIR BBS.
  521.  
  522.    Remember, should you have any problems, questions or suggestions, be sure
  523.    to drop me a message on either of the aforementioned BBS'.  I am now a
  524.    PCRelay node (SUNRISE) and can be reached thru the SYSOP, BBSDOORS,
  525.    PCBhints RIME conferences.
  526.